Class WincacheHandler

Summary

Fully Qualified Name: CodeIgniter\Cache\Handlers\WincacheHandler
Implements: CacheInterface

Description

Cache handler for WinCache from Microsoft & IIS.

Windows-only, so not testable on travis-ci. Unusable methods flagged for code coverage ignoring.

Methods

Name Description Defined By
__construct() Constructor. WincacheHandler
clean() Will delete all items in the entire cache. WincacheHandler
decrement() Performs atomic decrementation of a raw stored value. WincacheHandler
delete() Deletes a specific item from the cache store. WincacheHandler
get() Attempts to fetch an item from the cache store. WincacheHandler
getCacheInfo() Returns information on the entire cache. WincacheHandler
getMetaData() Returns detailed information about the specific item in the cache. WincacheHandler
increment() Performs atomic incrementation of a raw stored value. WincacheHandler
initialize() Takes care of any handler-specific setup that must be done. WincacheHandler
isSupported() Determines if the driver is supported on this system. WincacheHandler
save() Saves an item to the cache store. WincacheHandler

Method Details

__construct()

Constructor.

Parameter Name Type Description
$config \type

Returns:

clean()

Will delete all items in the entire cache.

Returns: mixed

decrement()

Performs atomic decrementation of a raw stored value.

Parameter Name Type Description
$key string Cache
$offset int Step/value

Returns: mixed

delete()

Deletes a specific item from the cache store.

Parameter Name Type Description
$key string Cache

Returns: mixed

get()

Attempts to fetch an item from the cache store.

Parameter Name Type Description
$key string Cache

Returns: mixed

getCacheInfo()

Returns information on the entire cache.

Returns: mixed

getMetaData()

Returns detailed information about the specific item in the cache.

Parameter Name Type Description
$key string Cache

Returns: mixed

increment()

Performs atomic incrementation of a raw stored value.

Parameter Name Type Description
$key string Cache
$offset int Step/value

Returns: mixed

initialize()

Takes care of any handler-specific setup that must be done.

Returns:

isSupported()

Determines if the driver is supported on this system.

Returns: bool

save()

Saves an item to the cache store.

Parameter Name Type Description
$key string Cache
$value mixed The
$ttl int Time

Returns: mixed

Top